<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the pcmToWave method from the FlutterSoundHelper class, for the Dart programming language.">
  <title>pcmToWave method - FlutterSoundHelper class - flutter_sound_helper library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../../static-assets/github.css?v1">
  <link rel="stylesheet" href="../../static-assets/styles.css?v1">
  <link rel="icon" href="../../static-assets/favicon.png?v1">
  
</head>

<body data-base-href="../../" data-using-base-href="false" class="light-theme">
<div id="overlay-under-drawer"></div>
<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../../index.html">flutter_sound</a></li>
    <li><a href="../../public_flutter_sound_helper">public&#47;flutter_sound_helper.dart</a></li>
    <li><a href="../../public_flutter_sound_helper/FlutterSoundHelper-class.html">FlutterSoundHelper</a></li>
    <li class="self-crumb">pcmToWave method</li>
  </ol>
  <div class="self-name">pcmToWave</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button" title="Toggle brightness">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        dark_mode
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        light_mode
      </span>
    </label>
  </div>
</header>
<main>
<div
    id="dartdoc-main-content"
    class="main-content"
    data-above-sidebar="public_flutter_sound_helper&#47;FlutterSoundHelper-class-sidebar.html"
    data-below-sidebar="">
    <div>
<h1><span class="kind-method">pcmToWave</span> method 
</h1></div>

    <section class="multi-line-signature">
      
<span class="returntype"><a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
<span class="name ">pcmToWave</span>(<wbr>{<ol class="parameter-list"> <li><span class="parameter" id="pcmToWave-param-inputFile"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">inputFile</span>, </span></li>
<li><span class="parameter" id="pcmToWave-param-outputFile"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">outputFile</span>, </span></li>
<li><span class="parameter" id="pcmToWave-param-numChannels"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">numChannels</span> = <span class="default-value">1</span>, </span></li>
<li><span class="parameter" id="pcmToWave-param-sampleRate"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">sampleRate</span> = <span class="default-value">16000</span>, </span></li>
<li><span class="parameter" id="pcmToWave-param-codec"><span class="type-annotation"><a href="https://pub.dev/documentation/flutter_sound_platform_interface/9.28.0/flutter_sound_platform_interface/Codec.html">Codec</a></span> <span class="parameter-name">codec</span> = <span class="default-value">fs_codec.Codec.pcm16</span>, </span></li>
</ol>})

      

    </section>
    
<section class="desc markdown">
  <p>Converts a raw PCM file to a WAVE file.</p>
<hr>
<p>Add a WAVE header in front of the PCM data
This verb is usefull to convert a Raw PCM file to a Wave file.
It adds a <code>Wave</code> envelop to the PCM file, so that the file can be played back with <code>startPlayer()</code>.</p>
<p>Note: the parameters <code>numChannels</code> and <code>sampleRate</code> <strong>are mandatory, and must match the actual PCM data</strong>.</p>
<p><a href="/tau/guides/guides-pcm-wave.html">See here</a> a discussion about <code>Raw PCM</code> and <code>WAVE</code> file format.</p>
<h2 id="parameters">Parameters</h2>
<ul>
<li><strong><em>inputFile:</em></strong> is a file path to your input file</li>
<li><strong><em>outputFile:</em></strong> is a path to your output file</li>
<li><strong><em>numChannels:</em></strong> is the number of channels of your file</li>
<li><strong><em>sampleRate</em></strong> is the sample rate of your data</li>
<li><strong><em>codec</em></strong> is either <a href="https://pub.dev/documentation/flutter_sound_platform_interface/9.28.0/flutter_sound_platform_interface/Codec.html">fs_codec.Codec.pcm16</a> or <a href="https://pub.dev/documentation/flutter_sound_platform_interface/9.28.0/flutter_sound_platform_interface/Codec.html">fs_codec.Codec.pcmFloat32</a></li>
</ul>
<h2 id="example">Example</h2>
<pre class="language-dart"><code>FlutterSoundHelper().pcmToWave (
    inputFile: 'foo.pcm',
    outputFile: 'foo.wav',
    numChannels: 2 // stereo
    samplerate: 48000,
    codec: fs_codec.Codec.pcm16
 );
</code></pre>
<hr>
</section>


    
<section class="summary source-code" id="source">
  <h2><span>Implementation</span></h2>
  <pre class="language-dart"><code class="language-dart">Future&lt;void&gt; pcmToWave({
  required String inputFile,
  required String outputFile,
  int numChannels = 1,
  int sampleRate = 16000,
  fs_codec.Codec codec = fs_codec.Codec.pcm16,
}) async {
  if (codec != fs_codec.Codec.pcm16 &amp;&amp; codec != fs_codec.Codec.pcmFloat32) {
    throw (Exception(&#39;Bad codec&#39;));
  }
  var filIn = File(inputFile);
  var filOut = File(outputFile);
  var size = filIn.lengthSync();
  logger.i(
    &#39;pcmToWave() : input = $inputFile,  output = $outputFile,  size = $size&#39;,
  );
  var sink = filOut.openWrite();

  var header = WaveHeader(
    codec == fs_codec.Codec.pcm16
        ? WaveHeader.formatInt
        : WaveHeader.formatFloat,
    numChannels = numChannels, &#47;&#47;
    sampleRate = sampleRate,
    codec == fs_codec.Codec.pcm16 ? 16 : 32, &#47;&#47; 16 bits per byte
    size, &#47;&#47; total number of bytes
  );
  header.write(sink);
  await filIn.open();
  var buffer = filIn.readAsBytesSync();
  sink.add(buffer.toList());
  await sink.close();
}</code></pre>
</section>


  </div> <!-- /.main-content -->
  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
    <li><a href="../../index.html">flutter_sound</a></li>
    <li><a href="../../public_flutter_sound_helper">flutter_sound_helper</a></li>
    <li><a href="../../public_flutter_sound_helper/FlutterSoundHelper-class.html">FlutterSoundHelper</a></li>
    <li class="self-crumb">pcmToWave method</li>
</ol>

    <h5>FlutterSoundHelper class</h5>
    <div id="dartdoc-sidebar-left-content"></div>
  </div><!--/.sidebar-offcanvas-->
  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
</div><!--/.sidebar-offcanvas-->
</main>
<footer>
  <span class="no-break">
    flutter_sound
      9.28.0
  </span>
  
</footer>


<script src="../../static-assets/highlight.pack.js?v1"></script>
<script src="../../static-assets/docs.dart.js"></script>

</body>
</html>

